/*
 * Copyright 2023 Amazon.com, Inc. or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package software.amazon.lambda.powertools.idempotency;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * &#64;IdempotencyKey is used to signal that a method parameter is used as a key for idempotency.<br/>
 * Must be used in conjunction with the &#64;Idempotency annotation.<br/>
 * Example:<br/>
 * <pre>
 *     &#64;Idempotent
 *     private MyObject subMethod(String param1, @IdempotencyKey String param2) {
 *         // ...
 *         return something;
 *     }
 * </pre>
 * Note: This annotation is not needed when the method only has one parameter.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface IdempotencyKey {
}
